-
Notifications
You must be signed in to change notification settings - Fork 342
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update documentation #293
Update documentation #293
Conversation
glensc
commented
Jul 11, 2020
•
edited
Loading
edited
- Direct user to readme from run list view, rather having instructions duplicated
- Update xhgui releases link (preinheimer -> perftools)
- Briefly describe how php-profiling works and how to import jsonlines files.
- Remove extension install instructions (profiling data is not the goal of this project)
- Update profiling logic to be abstract and how to do offline profiling
- Remove ext-dom phpunit requirement (the list IMHO incomplete, and phpunit is not required for application run)
- Move file saver block: Update file saver documentation php-profiler#19
- Move profiling.enable docs: Import profiler.enable documentation from xhgui project php-profiler#20
- Move profile.simple_url docs: Import simple url config from xhgui readme php-profiler#22
- Move ignored_functions docs: Import ignored_functions from xhgui documentation php-profiler#23
@markstory what is the proper capitalization of XHGUI? I want to be consistent in the documentation.
|
Profiling extension detail is not part of this project
Running unit tests is not main application concern and the list is most likely incomplete.
Account that mongodb and pdo are both allowed
the rewritten file saver block documentation in profiler package: perftools/php-profiler#19 |
Moving profiling.enable docs: perftools/php-profiler#20 |
I've tried to use XHGui in the past, but we can always change it if that is an oddly shaped word. |
there are profiler related config options in this project:
these should be removed from here, but not sure when :) |
This is in my opinion good enough to merge. @perftools/maintainers @Krinkle WDYT? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. Also +1 for "XHGui" as the canonical spelling I've personally used/preferred.